home *** CD-ROM | disk | FTP | other *** search
/ Monster Media 1996 #15 / Monster Media Number 15 (Monster Media)(July 1996).ISO / os2 / pmics2b3.zip / README < prev   
Text File  |  1996-05-22  |  18KB  |  419 lines
  1.                 ====================================
  2.                 PMICS User Guide: version 2.0 BETA 3
  3.                 ====================================
  4.  
  5. ------------
  6. Introduction
  7. ------------
  8.  
  9. PMICS is an OS/2 Warp interface for playing chess via the numerous chess
  10. servers found on the internet. PMICS requires OS/2 Warp V3.0 or better and a
  11. TCP/IP connection to the internet (such as the IBM Internet Connection supplied
  12. on the OS/2 Warp BonusPak, or OS/2 Warp Connect). You must also use a mouse.
  13.  
  14. If you are new to internet chess, it is best to connect to the server in
  15. text mode first to get a feel for what goes on. This will also help you to
  16. select a handle which is not already in use.
  17.  
  18. Telnet to fics.onenet.net at port 5000 to enter the server in text mode.
  19.  
  20.  
  21. -----------------------
  22. About this beta version
  23. -----------------------
  24.  
  25. This is a completely re-worked version of the original PMICS. New users will
  26. find it easy to set up and get going.
  27.  
  28. Many things have changed from PMICS V1.0, including the author! First, PMICS
  29. supports TCP/IP and OS/2 Warp *only*. There is no longer any support for shell
  30. accounts - sorry.
  31.  
  32. Configuration is done using a notebook rather than the command line. If you
  33. have an existing program icon for PMICS, you can now remove all the parameters.
  34.  
  35.  
  36. -------------------
  37. Changes from Beta 2
  38. -------------------
  39.  
  40. Beta 3 is completely different internally from beta 2. There are lots of new
  41. features and many improvements.
  42.  
  43. * The entire 'plumbing' of PMICS has been changed such that all game-related
  44.   events are detected. The title bar of a window shows the state of the
  45.   current game. Basically, it now works the way it should!
  46.  
  47. * Multiple games can now be observed simultaneously! For example, you can
  48.   observe both boards of a bughouse game. The first observed game will use the
  49.   main board. Further games will open smaller observation windows. PMICS will
  50.   keep track of the observation window positions. If you are observing a game
  51.   and then start playing, the played game will automatically use the main board.
  52.   The swap button on the observation window toolbar will swap the main board
  53.   game with the observation game.
  54.  
  55.   Cool trick: if a simul match is playing, type the command 'obs <simul player>'
  56.               and watch all the games at once!
  57.  
  58.   Note: FICS automatically unobserves games when you play (see Known Bugs). If
  59.         you use ICC, add the command 'set unobserve 0' to your login script to
  60.         continue observing games while you play.
  61.  
  62. * You can configure PMICS to automatically observe the partner board when you
  63.   watch or play a bughouse game. This is done by reading the finger notes of one
  64.   of the players in the first game.
  65.  
  66. * Command entry has been completely reworked. The buttons next to the command
  67.   line set the required mode. They are (in order) tell, channel tell, say,
  68.   finger, shout and it. When you select a button, the appropriate command is
  69.   automatically placed on the command line and the cursor is positioned so that
  70.   you can type immediately. Selecting the tell or finger modes will display a
  71.   list of gathered player names to select from. Selecting the channel tell mode
  72.   will display a spinner of channel numbers. Return to normal command entry by
  73.   deselecting the active mode button.
  74.  
  75. * The command line now has a retrievable history. Press the cursor up key to
  76.   retrieve old commands. The up and down keys will move through the history. Esc
  77.   will clear the command line. Commands are stored such that the most recently
  78.   used commands appear first.
  79.  
  80. * If you have TimeSeal for OS/2 you can now automatically set up a TimeSeal
  81.   connection to a host. Make sure that the TimeSeal executable is called
  82.   TIMESEAL.EXE and is in the same directory as PMICS.
  83.  
  84. * Toolbars now update themselves dynamically according to the state of the
  85.   current game. For example, examining a game will make the toolbar display
  86.   buttons for moving backwards and forwards.
  87.  
  88. * The menu bar has been removed.  The functions it originally performed are now
  89.   located on the toolbar, the board popup menu and the dialogue controls next to
  90.   the command line.
  91.  
  92. * Player names can be gathered from the server. Each time a name appears in a
  93.   shout, tell, game etc. it is added to a combo box next to the command line.
  94.  
  95. * You can assign a login script to each host. This is a list of commands that
  96.   will be sent to the server after PMICS has sent its own login commands. Use it
  97.   to announce your presence to the masses!
  98.  
  99. * Notifications are now detected. These occur when people on your notify list
  100.   enter and leave the server. You can assign a colour and sound.
  101.  
  102. * The chess board now highlights the squares which change after every move. This
  103.   is especially useful during bughouse games and when you have disabled board
  104.   labels. You can configure the highlight colour for both white and black
  105.   squares.
  106.  
  107. * You can configure PMICS to automatically display the finger notes of someone
  108.   who challenges you to a match.
  109.  
  110. * Finger notes containing 'tells you:' or 'shouts:' are no longer interpreted as
  111.   events.
  112.  
  113. * All the sound configration options are available. You can now use a standard
  114.   file dialog to find sound files.
  115.  
  116. * Long multimedia sounds no longer pause the system.
  117.  
  118. * The open button on the toolbar is automatically selected when you start
  119.   playing a game. This reflects the open status on the server.
  120.  
  121. * The match dialog now appears in the centre of the board to reduce the risk of
  122.   obscuring the comms window.
  123.  
  124. * Fixed the default square and piece colours for 16-colour systems.
  125.  
  126. * Lots of little bug fixes and improvements.
  127.  
  128.  
  129. ----------------
  130. Installing PMICS
  131. ----------------
  132.  
  133. Create a directory on your system and copy the pmicstcp.exe file to it. You can
  134. set up a program icon for PMICS in the usual way. Future install scripts will do
  135. this for you.
  136.  
  137. If you have a PMICS.INI file from a previous beta, the options you have already
  138. set will be maintained. PMICS will create this file with default options if it
  139. does not exist.
  140.  
  141. If you have a PMICS.HLP file from a previous beta, you can delete it. Beta 3
  142. does not use it.
  143.  
  144.  
  145. -------------
  146. Running PMICS
  147. -------------
  148.  
  149. The first thing you should do is connect to the internet using your normal
  150. method.
  151.  
  152. The first time you run PMICS, click the Settings button on the toolbar to
  153. set up the interface the way you want it. Pay special attention to the settings
  154. for your chess server hosts. PMICS defaults to the Free Internet Chess Server
  155. at ics.onenet.net:5000. If this is your normal host, just enter your handle and
  156. password.
  157.  
  158. When you are done configuring, click the Login button on the toolbar and
  159. select the server you wish to use. The communication window will show the
  160. progress of the connection.
  161.  
  162. When you are connected - start playing!
  163.  
  164.  
  165. -----------------
  166. Configuring PMICS
  167. -----------------
  168.  
  169. The configuration notebook has 5 pages; Hosts, On-line, Display, Colours and
  170. Sounds. All changes made to the configuration take effect immediately - even
  171. if you are already connected to a server.
  172.  
  173. The Hosts page allows you to set up multiple chess servers. For each server
  174. you need a description, TCP/IP address and TCP/IP port number (usually 5000).
  175. You should also enter your registered handle and password to enable automatic
  176. login. If you are not a registered user, leave the password blank.
  177. The 'Map CR to LF' checkbox is normally checked. If the server does not seem
  178. to respond to your commands, try changing this. Advanced users can select
  179. TimeSeal-based logins and login scripts.
  180.  
  181. The On-line page allows you to set your preferences during a session with a
  182. chess server. They are mostly self-explanatory. Check the 'Autoflag' button to
  183. automatically flag when you are playing a game and time runs out.
  184.  
  185. The Display page allows you to set up the PMICS display to your preferences.
  186.  
  187. The Colours page allows you to change the colours used by most of the PMICS
  188. display elements.
  189.  
  190. The Sounds page allows you to attach sounds to some of the events that can
  191. occur when you are playing chess. If you have MMPM/2 installed and a working
  192. sound card, you can use standard .WAV files as well as beeps. When entering
  193. a sound filename, use a full path i.e. 'D:\MMOS2\SOUNDS\BOING.WAV'.
  194.  
  195.  
  196. -------------
  197. Playing chess
  198. -------------
  199.  
  200. Use the command line to enter commands to the chess server.
  201.  
  202. When playing a game, select a piece with the left mouse button and release
  203. the button over the target square.  A line will show the move you are about to
  204. make.
  205.  
  206. Clicking the right mouse button on the board displays a pop-up menu
  207. showing the available options for that square. This includes re-issuing the
  208. previous move, flipping the board display, setting the piece that pawns will
  209. promote to, dropping pieces in bughouse and setting up the board in examine. The
  210. menu only displays options relevant to the game on which you click.
  211.  
  212. PMICS recognizes challenge messages and pops up a dialog informing you
  213. of the match parameters.  This also works when PMICS is minimized.
  214.  
  215. You can change the font used for the terminal window using the Settings.
  216. You can grab the border separating the board and terminal windows and drag it
  217. to resize them.  The main use of this is to temporarily enlarge the terminal
  218. window, e.g. for viewing large chunks of text or intense chat mode.
  219.  
  220.  
  221. ----------------
  222. Issuing Commands
  223. ----------------
  224.  
  225. At the bottom of the PMICS window is a command line and a set of mode buttons.
  226. You can type commands to the server here. Press Enter to execute a command. Esc
  227. will clear the command line. You can retrieve previously issued commands using
  228. the cursor up and down keys.
  229.  
  230. The mode buttons are useful if you plan to do some heavy chatting or shouting.
  231. The modes are 't' for tell, 'c' for channel tell, 's' for say, 'f' for finger,
  232. 'S' for shout and 'i' for it. Clicking a mode button will automatically prefix
  233. the command line with the selected command and place the cursor such that you
  234. are ready to type. Pressing Enter to submit the command will return the command
  235. line to the selected mode prefix.
  236.  
  237. If you select the tell or finger modes, a combo box will appear next to the
  238. command line. You can select from the list of gathered names to automatically
  239. add the name to the command line.
  240.  
  241. If you select the channel tell mode, a spinner appears next to the command line.
  242. You can change the target channel using this. The channel number will
  243. automatically be added to the command line.
  244.  
  245. To return to normal command mode simply click the active mode button. To
  246. temporarily clear the command line and enter a different command, press Esc.
  247.  
  248.  
  249. -----------------
  250. The PMICS Toolbar
  251. -----------------
  252.  
  253. Main Board - no connection
  254. --------------------------
  255. Settings        Display the PMICS configuration dialog.
  256. login           Establish a connection to a chess server. If you are already
  257.                 connected, you will be asked if you want to drop the current
  258.                 connection.
  259.  
  260. Main board - connected
  261. ----------------------
  262. refresh         Press this button if the displayed position or status gets
  263.                 messed up (very unusual).
  264. open            Toggles your availablility for games.
  265. who             Lists all users logged in to the current server.
  266. avail           Lists all users available for games on the current server.
  267. games           Lists all the games currently being played on the server. To
  268.                 observe a game, type in the command 'obs <game number>' or
  269.                 'obs <player name>'.
  270. allobs          Lists all the games which are being observed, and who is
  271.                 observing them. Good for following the crowd!
  272.  
  273. Mini board
  274. ----------
  275. swap            Swaps the board displayed in the mini-window with the one
  276.                 displayed in the main window. Allows you to concentrate on any
  277.                 of the observed games.
  278.  
  279. Any board - observing game
  280. --------------------------
  281. moves           Displays the list of moves for the current game.
  282. unobserve       Removes game from the observation list. If the game is already
  283.                 inactive, the board is reset to the initial position. If this is
  284.                 done on a separate window, the window is closed.
  285.  
  286. Any board - playing game
  287. ------------------------
  288. draw            Issue a draw request.
  289. resign          Resigns the game you are playing.
  290. flag            Issues a flag command manually. Use this when your opponent
  291.                 runs out of time.
  292. accept          Sends an accept command i.e. to accept a takeback request
  293. decline         Sends a decline command i.e. to decline an abort request
  294. moves           Displays the list of moves for the current game.
  295.  
  296. Any board - examining game
  297. --------------------------
  298. moves           Displays the list of moves for the current game.
  299. start           Resets game to starting position
  300. backward        Moves back one move
  301. forward         Moves forward one move
  302. end             Move to final game position
  303. unexamine       Stops game examination.
  304.  
  305.  
  306. ----------
  307. Known Bugs
  308. ----------
  309.  
  310. *  If you use the configuration notebook, PMICS will trap on exit with a
  311.    SYS3170. This doesn't cause any harm, but can be a bit alarming. This is
  312.    caused by a bug in OpenClass and I'm waiting for IBM to fix it. I've chatted
  313.    with them and am awaiting their analysis of the problem.
  314.  
  315.    STOP PRESS!! During the packaging of this beta, IBM released a test-case of
  316.    CTO304 - the next fixpak for OpenClass. This fixes the trap problem on exit,
  317.    but makes toolbar buttons which display text only a little too large. I've
  318.    decided to release this beta using the new fix, since it eliminates a trap.
  319.    If the final fixpak sorts out the toolbar problem, I'll release a new build
  320.    of the beta.
  321.  
  322. *  Toolbar bitmaps are awful. Dammit Jim, I'm a programmer, not an artist.
  323.  
  324. *  Name combo on command line will 'flash' the list up the first time it
  325.    is used. It is fine after that.
  326.  
  327. *  Command line doesn't always keep focus. This occurs mostly when you scroll
  328.    the comms window and you reach the end.
  329.  
  330. *  FICS doesn't support the 'unobserve' variable found on the ICC. If you are
  331.    observing multiple games then begin a match, the observation windows will
  332.    not detect the server removing the games from the observation list. Simply
  333.    close the windows.
  334.  
  335. *  With 'auto observe bughouse' active - if you observe a bughouse game and the
  336.    game completes before the partner game is observed, the interface can get a
  337.    little confused when the next bughouse game is observed. It seems to sort
  338.    itself out eventually.
  339.  
  340. *  Multimedia sound has failed to initialise for me once or twice. I can't
  341.    reproduce this at will.
  342.  
  343.  
  344. -----------
  345. Future work
  346. -----------
  347.  
  348. *  Fix bugs.
  349. *  Proper help files.
  350. *  Better toolbar bitmaps. Possibly better piece bitmaps as well.
  351. *  Colouring and automatic handling of Tournament Director (tomato, mamer)
  352.    messages and notifications. Comments?
  353. *  Simplified selection of games for observe/examine.
  354. *  What do *you* want to see?
  355.  
  356. I need someone to test playing bughouse games and report the results. I've never
  357. played bughouse, so I haven't tested it myself.
  358.  
  359. I'm happy with the feature set now.  Barring any wonderful ideas that you folks
  360. come up with during this beta, the next beta will be a release candidate.  PMICS
  361. will then be released as version 2.1.
  362.  
  363.  
  364. --------------
  365. Update history
  366. --------------
  367.  
  368. 96/05/22   2.00    (beta3)
  369.                    See above for changes.
  370.  
  371. 96/04/14   2.00    (beta2)
  372.                    Paul Mitchell is now the code maintainer. All bug reports
  373.                    and enhancement requests to him.
  374.  
  375. 94/12/12   1.00    (beta)
  376. 94/11/22   1.00    (alpha)
  377.  
  378.  
  379. ---------------------
  380. Contacting the Author
  381. ---------------------
  382.  
  383. Paul Mitchell (aka MysticUK) can be reached as paulm@secondnature.co.uk. If
  384. you don't get a response within a couple of days, try 73064.761@compuserve.com
  385.  
  386.  
  387. ------------
  388. IMPORTANT!!!
  389. ------------
  390.  
  391. To be notified of new releases of PMICS, send me email. Just a simple "Hi, I'm
  392. using PMICS" will be fine. However, more would be better - read on...
  393.  
  394. It is my intention to make PMICS the best available chess interface for OS/2.
  395. However, I'd prefer that is the best chess interface available, period. I can't
  396. do this alone - I need help from you, yes YOU! :-)
  397.  
  398. I need to know what you think of PMICS and how I can improve it. I need to know
  399. if you love it or hate it - any feedback is good. A good OS/2 chess interface
  400. is good for OS/2. If it is the *best* interface available, it may just help to
  401. bring people across from "the other side" :-).
  402.  
  403.  
  404. ----------------
  405. Acknowledgements
  406. ----------------
  407.  
  408. From Paul Mitchell:
  409. Many thanks to Kevin Nomura for the first version. Fond regards to Figbert and
  410. MrsFigbert for initial testing, comments and encouragement. Check out the OS/2
  411. version of Timeseal by Figbert. Respect to IBM, TeamOS/2 and all OS/2 users.
  412.  
  413. From Kevin Nomura:
  414. PMICS was inspired by the excellent DOS interface, GIICS, written by
  415. Tony Acero.  The bitmaps for the pieces are taken from the GNU program xboard.
  416. Serial port IOCTL magic was adapted from the PD comm program comtalk.
  417.  
  418. Kevin Nomura (aka woof) can be reached as chow@netcom.com
  419.